refactor(forge-stream): document storage type for each DataKey variant#299
Merged
Austinaminu2 merged 1 commit intoAustinaminu2:mainfrom Mar 30, 2026
Conversation
Fixes Austinaminu2#245. DataKey variants were undocumented, making it unclear which storage tier (instance vs persistent) each key uses and why. Changes: - Add inline comments to each DataKey variant in forge-stream explaining the storage type used and the rationale - Add a Storage Strategy section to contracts/forge-stream/README.md with a reference table and a checklist for contributors adding new keys - Add a Storage Type Selection subsection to CONTRIBUTING.md with a three-tier decision table and a pointer to forge-stream as an example No behaviour changes.
|
@zeekman Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
forge-stream'sDataKeyvariants had no documentation indicating whichSoroban storage tier they use or why. Contributors adding new keys had no
guidance, making it easy to accidentally use the wrong storage type.
Adds inline comments to each variant, a reference table in the contract
README, and a storage-type decision guide in CONTRIBUTING.md. No behaviour
changes.
Related issue
Testing done
Documentation-only change. No logic was modified.
Checklist
cargo fmt(or equivalent formatter)cargo clippy(or equivalent linter)Closes #245